JavaScript

{dialog.object}argumentValue Method

Syntax

{dialog.object}.argumentValue(argumentName);

Arguments

argumentNamestring

The name of the argument to get.

Returns

resultAny Type

Returns the argument value. If the argument doesn't exist, returns undefined.

Description

Get the value of an argument that was passed to the UX component.

Example

//Set the value of some span tag in a free-form edit region with the value of the 'whatstate' argument
var argName = "whatstate";
var argValue = {dialog.object}.argumentValue(argName);
var html = "";

if (argValue) {
    html = argValue;
} else {
    html = "'whatstate' argument does not exist.";
}

var ele = $('myspanid');
if (ele) {
    ele.innerHTML = html;
}